避免滥用 Kotlin 扩展函数
hi 这是 dhl 的第 54 篇原创文章
个人微信: hi-dhl
hi 大家好，我是 DHL。专注分享最新技术原创文章，涉及 Kotlin、Jetpack、算法动画、数据结构 、系统源码、 LeetCode / 剑指 Offer / 多线程 / 国内外大厂算法题 等等。
原标题：Effective Kotlin Item 46: Avoid member extensions 原地址：https://kt.academy/article/ek-member-extensions?utm_campaign=onCreate%20Digest&utm_medium=email&utm_source=Revue%20newsletter 原作者：Marcin Moskała 译者：DHL 本文已收录于仓库 https://github.com/hi-dhl/Technical-Article-Translation
当我们为类定义扩展函数时，它不会作为成员添加到类中。扩展函数是一种特殊的函数，它默认的第一个参数是函数的接受者，如下例所示，扩展函数被编译成普通函数。
fun String.isPhoneNumber(): Boolean =
length == 7 && all { it.isDigit() }
编译成一个类似于扩展函数的函数
fun isPhoneNumber(`$this$: String): Boolean =
$this$.length == 7 && $this`.all { it.isDigit() }
除了为类定义扩展函数之外，还可以定义成员扩展，甚至还可以在接口中定义扩展。
interface PhoneBook {
fun String.isPhoneNumber(): Boolean
}
class Fizz : PhoneBook {
override fun String.isPhoneNumber(): Boolean =
this.length == 7 && this.all { it.isDigit() }
}
不要仅仅为了限制可见性，而将函数定义为成员扩展函数，如下所示。
// Bad practice, do not do this
class PhoneBookIncorrect {
fun verify(number: String): Boolean {
require(number.isPhoneNumber())
// ...
}
// ...
fun String.isPhoneNumber(): Boolean =
this.length == 7 && this.all { it.isDigit() }
}
其实这样做并没有真正限制可见性，它只会使扩展函数变得更加复杂，调用的时候，需要同时提供扩展接受者和调度接受者。
PhoneBookIncorrect().apply {
"1234567890".isPhoneNumber()
}
你应该使用可见修饰符，限制扩展函数的可见性，而不是将其设置成员扩展函数。
class PhoneBook {
fun verify(number: String): Boolean {
require(number.isPhoneNumber())
// ...
}
// ...
}
// This is how we limit extension functions visibility
private fun String.isPhoneNumber(): Boolean =
this.length == 7 && this.all { it.isDigit() }
如果你需要将一个函数作为成员，并且希望像调用扩展函数一样使用它，请考虑使用let。
class PhoneBook(
private val phoneNumberVerifier: PhoneNumberVerifier
) {
fun verify(number: String): Boolean {
require(number.let(::isPhoneNumber))
}
private fun isPhoneNumber(number: String): Boolean =
phoneNumberVerifier.verify(number)
}
为什么需要避免成员扩展函数
建议尽量避免使用成员扩展函数，主要有以下几个原因：
不支持引用
val ref = String::isPhoneNumber
val str = "1234567890"
val boundedRef = str::isPhoneNumber
val refX = PhoneBookIncorrect::isPhoneNumber // ERROR
val book = PhoneBookIncorrect()
val boundedRefX = book::isPhoneNumber // ERROR
两个接受者隐式的访问可能会令人困惑
class A {
val a = 10
}
class B {
val a = 20
val b = 30
fun A.test() = a + b // Is it 40 or 50?
}
当我们期望修改引用接受者的时候，我们不清楚是修改的是扩展接受者还是调度接受者
class A {
//...
}
class B {
//...
fun A.update() ... // Does it update A or B?
}
对于经验较少的开发人员来说，看到成员扩展可能是违反直觉，可读性很差。
避免,而不是禁止
这条规则并不适用于任何地方，最明显的情况是，当我们定义 DSL 时，需要使用成员扩展。
DSL 全称 Domain Specific Language 即 领域特定语言，在 Kotlin 中最主要的实现方式是高阶函数
当需要调用在某个作用域上定义的函数时，成员扩展也是非常有用的，举两个例子，一个例子可能是使用 produce 生成 Channel 的成员函数，另一个是定义在接口中的，集成测试函数。
class OrderUseCase(
// ...
) {
// ...
private fun CoroutineScope.produceOrders() =
produce<Order> {
var page = 0
do {
val orders = api
.requestOrders(page = page++)
.orEmpty()
for (order in orders) send(order)
} while (orders.isNotEmpty())
}
}
interface UserApiTrait {
fun TestApplicationEngine.requestRegisterUser(
token: String,
request: RegisterUserRequest
): UserJson? = ...
fun TestApplicationEngine.requestGetUserSelf(
token: String
): UserJson? = ...
// ...
}
我们建议尽可能避免定义成员扩展函数，但是如果它们是最好的选择，我们还是会使用它们。
总结
本篇文章主要介绍了，应当尽量避免使用成员扩展函数，除了特殊的场景例如 DSL， 因为成员扩展函数存在很多缺点，我们应该尽量避免，这只是建议，不是强制，更不应该使用成员扩展函数来限制可见性，你应该使用可见修饰符，限制扩展函数的可见性。
推荐阅读：
感谢大家帮忙 在看、点赞、分享 给身边的朋友
持续分享最新的技术
文末链接包含各类技术知识体系
👇🏻 真诚推荐你关注我👇🏻
因微信公众号更改了推送机制
可能无法及时看到最新文章
将公众号设为 星标
或常为文章点 在看
即可及时收到最新文章
欢迎前往 博客 查看更多 Kotlin、Jetpack 、动画算法图解、系统源码分析等等文章。以及开源项目、LeetCode / 剑指 offer / 国内外大厂面试题 / 多线程 题解。
https://www.hi-dhl.com